Skip to content

docs: add AGENTS.md and CONTRIBUTING.md#194

Merged
pcarleton merged 2 commits intomainfrom
paulc/add-agents-md
Mar 25, 2026
Merged

docs: add AGENTS.md and CONTRIBUTING.md#194
pcarleton merged 2 commits intomainfrom
paulc/add-agents-md

Conversation

@pcarleton
Copy link
Copy Markdown
Member

Codifies scenario design guidelines distilled from past PR reviews so contributors (human and AI) see them before opening a PR instead of during review.

AGENTS.md

  • Fewer scenarios, more checks — each scenario spins up a server and runs in CI for every SDK. One scenario with 10 checks beats 10 scenarios.
  • Granularity heuristic: "would it make sense for someone to implement a server/client that does just this scenario?"
  • Same check id for SUCCESS and FAIL; optimize for Ctrl+F on the slug
  • Extend the everything-client/server rather than adding new example files; prove pass and fail
  • Use the existing CLI runner, don't add parallel entry points
  • Open an issue first for bugs or scenario proposals
  • Don't point an AI agent at the repo with a generic "find bugs" prompt — target specific spec MUSTs or open issues

CONTRIBUTING.md

Short human-facing entry point: setup, how to run a scenario locally, links to AGENTS.md for the full design guide.

Codifies scenario design guidelines from past PR reviews:
- fewer scenarios with more checks (CI cost multiplies per-SDK)
- same check id for SUCCESS and FAIL, optimize for Ctrl+F
- extend the everything-client/server rather than adding new example files
- prove it passes and fails
- reuse the CLI runner, don't add parallel entry points

Also asks contributors to open an issue for discussion before a PR, and
to target specific spec MUSTs or open issues rather than running generic
AI bug-hunts against the harness.
@pkg-pr-new
Copy link
Copy Markdown

pkg-pr-new bot commented Mar 25, 2026

Open in StackBlitz

npx https://pkg.pr.new/@modelcontextprotocol/conformance@194

commit: 6f92f46

@pcarleton pcarleton merged commit 4859a81 into main Mar 25, 2026
8 checks passed
@pcarleton pcarleton deleted the paulc/add-agents-md branch March 25, 2026 11:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant